/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.common;

import java.util.Date;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/** Parameters for repeatable stage values. */
@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(of = {"index", "startDate", "endDate", "dimension"})
public class RepeatableStageParams {
  private int index;

  // Related to execution date
  private Date startDate;

  // Related to execution date
  private Date endDate;

  private boolean defaultObject = true;

  private String dimension;

  @Override
  public String toString() {
    return "index:"
        + index
        + " startDate:"
        + startDate
        + " endDate: "
        + endDate
        + " dimension: "
        + dimension;
  }

  /**
   * Instantiates this object with the given arguments.
   *
   * @param dimension the dimension param.
   * @return an instance of this object.
   */
  public static RepeatableStageParams of(String dimension) {
    RepeatableStageParams params = new RepeatableStageParams();
    params.setDimension(dimension);

    return params;
  }

  /**
   * Instantiates this object with the given arguments.
   *
   * @param index the index.
   * @return an instance of this object.
   */
  public static RepeatableStageParams of(int index) {
    RepeatableStageParams params = new RepeatableStageParams();
    params.setIndex(index);
    params.setDefaultObject(false);

    return params;
  }

  /**
   * Instantiates this object with the given arguments.
   *
   * @param index the index.
   * @param dimension the dimension param.
   * @return an instance of this object.
   */
  public static RepeatableStageParams of(int index, String dimension) {
    RepeatableStageParams params = of(index);
    params.setDimension(dimension);

    return params;
  }
}
